home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / perl5 / ExtUtils::Manifest.z / ExtUtils::Manifest
Encoding:
Text File  |  1998-10-30  |  6.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))                                    EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ExtUtils::Manifest - utilities to write and check a MANIFEST file
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      require ExtUtils::Manifest;
  13.  
  14.      ExtUtils::Manifest::mkmanifest;
  15.  
  16.      ExtUtils::Manifest::manicheck;
  17.  
  18.      ExtUtils::Manifest::filecheck;
  19.  
  20.      ExtUtils::Manifest::fullcheck;
  21.  
  22.      ExtUtils::Manifest::skipcheck;
  23.  
  24.      ExtUtild::Manifest::manifind();
  25.  
  26.      ExtUtils::Manifest::maniread($file);
  27.  
  28.      ExtUtils::Manifest::manicopy($read,$target,$how);
  29.  
  30. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  31.      _M_k_m_a_n_i_f_e_s_t() writes all files in and below the current directory to a
  32.      file named in the global variable $ExtUtils::Manifest::MANIFEST (which
  33.      defaults to MANIFEST) in the current directory. It works similar to
  34.  
  35.          find . -print
  36.  
  37.      but in doing so checks each line in an existing MANIFEST file and
  38.      includes any comments that are found in the existing MANIFEST file in the
  39.      new one. Anything between white space and an end of line within a
  40.      MANIFEST file is considered to be a comment. Filenames and comments are
  41.      seperated by one or more TAB characters in the output. All files that
  42.      match any regular expression in a file MANIFEST.SKIP (if such a file
  43.      exists) are ignored.
  44.  
  45.      _M_a_n_i_c_h_e_c_k() checks if all the files within a MANIFEST in the current
  46.      directory really do exist. It only reports discrepancies and exits
  47.      silently if MANIFEST and the tree below the current directory are in
  48.      sync.
  49.  
  50.      _F_i_l_e_c_h_e_c_k() finds files below the current directory that are not
  51.      mentioned in the MANIFEST file. An optional file MANIFEST.SKIP will be
  52.      consulted. Any file matching a regular expression in such a file will not
  53.      be reported as missing in the MANIFEST file.
  54.  
  55.      _F_u_l_l_c_h_e_c_k() does both a _m_a_n_i_c_h_e_c_k() and a _f_i_l_e_c_h_e_c_k().
  56.  
  57.      _S_k_i_p_c_h_e_c_k() lists all the files that are skipped due to your
  58.      MANIFEST.SKIP file.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))                                    EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))
  71.  
  72.  
  73.  
  74.      _M_a_n_i_f_i_n_d() retruns a hash reference. The keys of the hash are the files
  75.      found below the current directory.
  76.  
  77.      _M_a_n_i_r_e_a_d($file) reads a named MANIFEST file (defaults to MANIFEST in the
  78.      current directory) and returns a HASH reference with files being the keys
  79.      and comments being the values of the HASH.  Blank lines and lines which
  80.      start with # in the MANIFEST file are discarded.
  81.  
  82.      _M_a_n_i_c_o_p_y($_r_e_a_d,$_t_a_r_g_e_t,$_h_o_w) copies the files that are the keys in the
  83.      HASH %$_r_e_a_d to the named target directory. The HASH reference $_r_e_a_d is
  84.      typically returned by the _m_a_n_i_r_e_a_d() function. This function is useful
  85.      for producing a directory tree identical to the intended distribution
  86.      tree. The third parameter $how can be used to specify a different methods
  87.      of "copying". Valid values are cp, which actually copies the files, ln
  88.      which creates hard links, and best which mostly links the files but
  89.      copies any symbolic link to make a tree without any symbolic link. Best
  90.      is the default.
  91.  
  92. MMMMAAAANNNNIIIIFFFFEEEESSSSTTTT....SSSSKKKKIIIIPPPP
  93.      The file MANIFEST.SKIP may contain regular expressions of files that
  94.      should be ignored by _m_k_m_a_n_i_f_e_s_t() and _f_i_l_e_c_h_e_c_k(). The regular
  95.      expressions should appear one on each line. Blank lines and lines which
  96.      start with # are skipped.  Use \# if you need a regular expression to
  97.      start with a sharp character. A typical example:
  98.  
  99.          \bRCS\b
  100.          ^MANIFEST\.
  101.          ^Makefile$
  102.          ~$
  103.          \.html$
  104.          \.old$
  105.          ^blib/
  106.          ^MakeMaker-\d
  107.  
  108.  
  109. EEEEXXXXPPPPOOOORRRRTTTT____OOOOKKKK
  110.      &mkmanifest, &manicheck, &filecheck, &fullcheck, &maniread, and &manicopy
  111.      are exportable.
  112.  
  113. GGGGLLLLOOOOBBBBAAAALLLL VVVVAAAARRRRIIIIAAAABBBBLLLLEEEESSSS
  114.      $ExtUtils::Manifest::MANIFEST defaults to MANIFEST. Changing it results
  115.      in both a different MANIFEST and a different MANIFEST.SKIP file. This is
  116.      useful if you want to maintain different distributions for different
  117.      audiences (say a user version and a developer version including RCS).
  118.  
  119.      $ExtUtils::Manifest::Quiet defaults to 0. If set to a true value, all
  120.      functions act silently.
  121.  
  122. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  123.      All diagnostic output is sent to STDERR.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))                                    EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))
  137.  
  138.  
  139.  
  140.      Not in MANIFEST: _f_i_l_e
  141.           is reported if a file is found, that is missing in the MANIFEST file
  142.           which is excluded by a regular expression in the file MANIFEST.SKIP.
  143.  
  144.      No such file: _f_i_l_e
  145.           is reported if a file mentioned in a MANIFEST file does not exist.
  146.  
  147.      MANIFEST: $!
  148.           is reported if MANIFEST could not be opened.
  149.  
  150.      Added to MANIFEST: _f_i_l_e
  151.           is reported by _m_k_m_a_n_i_f_e_s_t() if $Verbose is set and a file is added
  152.           to MANIFEST. $Verbose is set to 1 by default.
  153.  
  154. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  155.      the _E_x_t_U_t_i_l_s::_M_a_k_e_M_a_k_e_r manpage which has handy targets for most of the
  156.      functionality.
  157.  
  158. AAAAUUUUTTTTHHHHOOOORRRR
  159.      Andreas Koenig <_k_o_e_n_i_g@_f_r_a_n_z._w_w._T_U-_B_e_r_l_i_n._D_E>
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.